@vonage/users

Vonage Users SDK for Node.js

This is the Vonage Users SDK for Node.js for use with Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.

For full API documentation refer to developer.nexmo.com.

• Installation
• Usage
• Promises

Installation

With NPM

npm install @vonage/users

With Yarn

yarn add @vonage/users

Usage

The SDK can be used standalone from the main Vonage Server SDK for Node.js if you only need to use the Users API. All you need to do is require('@vonage/users'), and use the returned object to create your own client.

const {Auth} = require('@vonage/auth');
const {User} = require('@vonage/user');

const usersClient = new User(new Auth({
  apiKey: API_KEY,
  apiSecret: API_SECRET,
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
}), options);

Promises

Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use await to wait for a response.

const resp = await usersClient.getUser(USER_ID);

usersClient.getUser(USER_ID)
  .then(resp => console.log(resp))
  .catch(err => console.error(err));

Testing

Run:

npm run test